Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

phan: Fix more phpdocs #37042

Merged
merged 7 commits into from
Apr 25, 2024
Merged

phan: Fix more phpdocs #37042

merged 7 commits into from
Apr 25, 2024

Conversation

anomiex
Copy link
Contributor

@anomiex anomiex commented Apr 23, 2024

Proposed changes:

Another pass through the PhanUndeclared issues looking for issues that are due to phpdocs being wrong.

Other information:

  • Have you written new tests for your changes, if applicable?
  • Have you checked the E2E test CI results, and verified that your changes do not break them?
  • Have you tested your changes on WordPress.com, if applicable (if so, you'll see a generated comment below with a script to run)?

Jetpack product discussion

None

Does this pull request change what data or activity we track or use?

No

Testing instructions:

  • CI happy?

@anomiex
phan: Fix more phpdocs
2ea6bd1 
Another pass through the PhanUndeclared issues looking for issues that
are due to phpdocs being wrong.
@anomiex anomiex added [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. [Type] Janitorial [Pri] Normal labels Apr 23, 2024
@anomiex anomiex requested a review from a team April 23, 2024 23:22
@anomiex anomiex self-assigned this Apr 23, 2024
@anomiex anomiex enabled auto-merge (squash) April 23, 2024 23:23
@github-actions github-actions bot added [Block] Paid Content aka Premium Content [Feature] Contact Form [Feature] Custom CSS [Feature] Extra Sidebar Widgets [Feature] Photon aka "Image CDN". Feature developed in the Image CDN package and shipped in multiple plugins [Focus] Compatibility Ensuring our products play well with third-parties [mu wpcom Feature] Launchpad [mu wpcom Feature] Block Patterns [mu wpcom Feature] Verbum Comments Verbum, a better comment experience, app developed in the mu-wpcom plugin [Package] Connection [Package] Forms [Package] Identity Crisis This package no longer exists in the monorepo. It was merged into [Package] Connection. [Package] Image CDN [Package] Import [Package] Jetpack mu wpcom WordPress.com Features [Package] My Jetpack [Package] Publicize [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] Stats Data [Package] Sync [Package] VideoPress [Package] WAF [Package] WP JS Data Sync labels Apr 23, 2024
@github-actions github-actions bot added [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Inspect [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Tests] Includes Tests labels Apr 23, 2024
@github-actions GitHub Actions
Copy link
Contributor

Thank you for your PR!

When contributing to Jetpack, we have a few suggestions that can help us test and review your patch:

  • ✅ Include a description of your PR changes.
  • ✅ Add a "[Status]" label (In Progress, Needs Team Review, ...).
  • ✅ Add testing instructions.
  • ✅ Specify whether this PR includes any changes to data or privacy.
  • ✅ Add changelog entries to affected projects

This comment will be updated as you work on your PR and make changes. If you think that some of those checks are not needed for your PR, please explain why you think so. Thanks for cooperation 🤖

The e2e test report can be found here. Please note that it can take a few minutes after the e2e tests checks are complete for the report to be available.

Once your PR is ready for review, check one last time that all required checks appearing at the bottom of this PR are passing or skipped.
Then, add the "[Status] Needs Team Review" label and ask someone from your team review the code. Once reviewed, it can then be merged.
If you need an extra review from someone familiar with the codebase, you can update the labels from "[Status] Needs Team Review" to "[Status] Needs Review", and in that case Jetpack Approvers will do a final review of your PR.

Jetpack plugin:

The Jetpack plugin has different release cadences depending on the platform:

  • WordPress.com Simple releases happen daily.
  • WoA releases happen weekly.
  • Releases to self-hosted sites happen monthly. The next release is scheduled for May 7, 2024 (scheduled code freeze on May 6, 2024).

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Boost plugin:

  • Next scheduled release: May 7, 2024.
  • Scheduled code freeze: April 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

Inspect plugin:

  • Next scheduled release: May 7, 2024.
  • Scheduled code freeze: April 29, 2024.

If you have any questions about the release process, please ask in the #jetpack-releases channel on Slack.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 23, 2024 •
edited
Loading

Are you an Automattician? Please test your changes on all WordPress.com environments to help mitigate accidental explosions.

  • To test on WoA, go to the Plugins menu on a WordPress.com Simple site. Click on the "Upload" button and follow the upgrade flow to be able to upload, install, and activate the Jetpack Beta plugin. Once the plugin is active, go to Jetpack > Jetpack Beta, select your plugin, and enable the fix/more-phan-undefined-because-of-phpdoc branch.

    • For jetpack-mu-wpcom changes, also add define( 'JETPACK_MU_WPCOM_LOAD_VIA_BETA_PLUGIN', true ); to your wp-config.php file.

  • To test on Simple, run the following command on your sandbox:

    bin/jetpack-downloader test jetpack fix/more-phan-undefined-because-of-phpdoc

    bin/jetpack-downloader test jetpack-mu-wpcom-plugin fix/more-phan-undefined-because-of-phpdoc

Interested in more tips and information?

  • In your local development environment, use the jetpack rsync command to sync your changes to a WoA dev blog.
  • Read more about our development workflow here: PCYsg-eg0-p2
  • Figure out when your changes will be shipped to customers here: PCYsg-eg5-p2

tbradsha
tbradsha reviewed Apr 24, 2024
View reviewed changes
projects/packages/jetpack-mu-wpcom/src/features/launchpad/class-launchpad-task-lists.php
@@ -6,6 +6,12 @@
* @since 1.5.0
*/

// Type aliases used in a bunch of places in this file. Unfortunately Phan doesn't have a way to set these more globally than copy-pasting them into each file needing them.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😞

tbradsha
tbradsha reviewed Apr 24, 2024
View reviewed changes
Copy link
Contributor

@tbradsha tbradsha left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, though one conflict.

@anomiex anomiex merged commit f31bc10 into trunk Apr 25, 2024
68 of 72 checks passed
@anomiex anomiex deleted the fix/more-phan-undefined-because-of-phpdoc branch April 25, 2024 17:42
@github-actions github-actions bot removed the [Status] Needs Review To request a review from fellow Jetpack developers. Label will be renamed soon. label Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tbradsha tbradsha tbradsha approved these changes

Assignees

@anomiex anomiex

Labels
[Block] Paid Content aka Premium Content [Feature] Contact Form [Feature] Custom CSS [Feature] Extra Sidebar Widgets [Feature] Photon aka "Image CDN". Feature developed in the Image CDN package and shipped in multiple plugins [Focus] Compatibility Ensuring our products play well with third-parties [mu wpcom Feature] Block Patterns [mu wpcom Feature] Launchpad [mu wpcom Feature] Verbum Comments Verbum, a better comment experience, app developed in the mu-wpcom plugin [Package] Connection [Package] Forms [Package] Identity Crisis This package no longer exists in the monorepo. It was merged into [Package] Connection. [Package] Image CDN [Package] Import [Package] Jetpack mu wpcom WordPress.com Features [Package] My Jetpack [Package] Publicize [Package] Search Contains core Search functionality for Jetpack and Search plugins [Package] Stats Data [Package] Sync [Package] VideoPress [Package] WAF [Package] WP JS Data Sync [Plugin] Boost A feature to speed up the site and improve performance. [Plugin] Inspect [Plugin] Jetpack Issues about the Jetpack plugin. https://wordpress.org/plugins/jetpack/ [Pri] Normal [Tests] Includes Tests [Type] Janitorial
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@anomiex @tbradsha